dxp-ux
ServiceInventory - TMF 638
1. GET /service
This operation retrieves the services with products for the provided accountNumber.
URL
https://[host]:[port]/dxp-ux/v1/{businessId}/serviceURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| lob | string | The Line of Business Identifier Allowed values: FIXED, POSTPAID | N |
Query Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| relatedEntity.id | string | unique identifier of the account. (BillingAccountID) | Y(PA,CWC) |
| state | string | state of the service Enum:[ Active ] | N(PA,CWC) |
| filter | string | This field is to reduce the BSS operations and to increase the API performance Possible Values: optimize | N(PA,CWC) |
Data Model
Response Data Model
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique identifier of the service / MSISDN / serviceNumber | Y(PA,CWC) |
| href | string | reference link of the service | Y(PA,CWC) |
| serviceType | string | Business type of the service | Y(PA,CWC) |
| serviceDate | string | Date when the service was created | Y(PA,CWC) |
| startDate | string($date-time) | Date when the service starts | N/A(PA), N(CWC) |
| endDate | string($date-time) | Date when the service ends | N/A(PA), N(CWC) |
| category | string | Is it a customer facing or resource facing service | Y(PA,CWC) |
| isServiceEnabled | boolean | If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service as failed. | Y(PA,CWC) |
| name | string | Name of the service | N/A(PA), N(CWC) |
| state | string | state of the service | Y(PA,CWC) |
| hasStarted | boolean | If TRUE, this Service has already been started | Y(PA,CWC) |
| serviceSpecification | object | A service specification reference. The specification from which this service was instantiated. | Y(PA,CWC) |
| serviceSpecification.id | string | unique identifier | Y(PA,CWC) |
| serviceSpecification.@type | string | When sub-classing, this defines the sub-class Extensible name | Y(PA,CWC) |
| serviceSpecification.name | string | Name of the related entity. | Y(PA,CWC) |
| feature[] | Object Array | A list of feature associated with this service. | Y(PA,CWC) |
| feature[].name | string | This is the name for the feature | Y(PA,CWC) |
| feature[].isEnabled | boolean | True if this feature is enabled. Default is true | Y(PA,CWC) |
| supportingService[] | Object Array | A collection of services that support this service | Y(PA,CWC) |
| supportingService[].id | string | Unique identifier of the service | Y(PA,CWC) |
| supportingService[].name | string | A list of supporting services | Y(PA,CWC) |
| supportingService[].feature[] | Object Array | A list of feature associated with this service. | Y(PA),N(CWC) |
| supportingService[].feature[].name | string | This is the name for the feature | Y(PA),N(CWC) |
| supportingService[].feature[].isEnabled | boolean | True if this feature is enabled. Default is true | Y(PA),N(CWC) |
| supportingService[].serviceSpecification.id | string | unique identifier | N/A(PA), Y(CWC) |
| supportingService[].serviceSpecification.name | string | Name of the related entity. | N/A(PA), Y(CWC) |
| serviceCharacteristic[] | Object Array | A list of characteristics that characterize this service | Y(PA,CWC) |
| serviceCharacteristic[].name | string | Name of the characteristic | Y(PA,CWC) |
| serviceCharacteristic[].id | string | identifier of the characteristic | Y(PA,CWC) |
| serviceCharacteristic[].value | object | Value of the characteristic | Y(PA,CWC) |
| serviceCharacteristic[].value.productStatusCode | string | status code of the product | Y(PA,CWC) |
| serviceCharacteristic[].value.uniqueProductId | string | unique identifier of the product | Y(PA,CWC) |
| serviceCharacteristic[].value.productActive | boolean | active state of product | Y(PA,CWC) |
| serviceCharacteristic[].value.price | number | price of the product | Y(PA),N(CWC) |
| serviceCharacteristic[].value.modelNumber | string | modelNumber value for the service characteristic | Y(PA),N(CWC) |
| serviceCharacteristic[].value.macAddress | string | macAddress value for the service characteristic | N/A(PA),N(CWC) |
| serviceCharacteristic[].value.voiceMacAddress | string | voiceMacAddress value for the service characteristic | N/A(PA),N(CWC) |
| serviceCharacteristic[].value.deviceStatusCode | string | deviceStatusCode value for the service characteristic | N/A(PA),N(CWC) |
| serviceCharacteristic[].value.serialNumber | string | serialNumber value for the service characteristic | N/A(PA), N(CWC) |
| serviceCharacteristic[].value.isPrimary | boolean | indicates if the product is primary | Y(PA),N(CWC) |
| serviceCharacteristic[].value.@type | string | type of the value | Y(PA),N(CWC) |
| serviceCharacteristic[].value.productType | string | type of the product | N/A(PA),N(CWC) |
| relatedParty[] | Object Array | A related party defines party or party role linked to a specific entity | Y(PA,CWC) |
| relatedParty[].id | string | unique identifier | Y(PA,CWC) |
| relatedParty[].role | string | role of the party | Y(PA,CWC) |
| serviceOrderItem[] | Object Array | A list of service order items related to this service | Y(PA,CWC) |
| serviceOrderItem[].itemId | string | Identifier of the order item where the service was managed | Y(PA,CWC) |
| serviceOrderItem[].serviceOrderId | string | Unique identifier of a related entity. | Y(PA,CWC) |
| place[] | Object Array | A list of places | Y(PA,CWC) |
| place[].id | string | Unique identifier of the place. | Y(PA,CWC) |
| place[].role | string | role of the address | Y(PA,CWC) |
| place[].streetName | string | name of the street | Y(PA,CWC) |
| place[].district | string | district of the place | Y(PA,CWC) |
| place[].province | string | province code. | Y(PA,CWC) |
| relatedEntity[] | Object Array | Related Entity reference. | N/A(PA),Y(CWC) |
| relatedEntity[].id | string | unique identifier | N/A(PA),Y(CWC) |
| relatedEntity[].role | string | Role played by the related entity | N/A(PA),Y(CWC) |
| relatedEntity[].@type | string | When sub-classing, this defines the sub-class Extensible name. | N/A(PA),Y(CWC) |
| @type | string | When sub-classing, this defines the sub-class Extensible name. | Y(PA,CWC) |
feature subResource - dataModel
| feature name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| mobileService | string | mobile service feature indicator. | Y(CWC),N(PA) | { "name": "exDirectory", "isEnabled": false } |
| exDirectory | string | working directory flag | Y(CWC),N(PA) | { "name": "mobileService", "isEnabled": false } |
| prepaidService | string | prepaid service indicator | Y(CWC),N(PA) | { "name": "prepaidService", "isEnabled": false } |
supportingService subResource - dataModel
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| id | string | Identifier of the service. | Y(PA,CWC) | [ { "id": "8767249754", "name": "phoneNumber", "feature": [ { "name": "portInNumber", "isEnabled": false } ], "serviceSpecification": { "id": "91722233", "name": "uniqueServiceId" } } ] |
| name | string | Name of the supportingService. | Y(PA,CWC) | [ { "id": "8767249754", "name": "phoneNumber", "feature": [ { "name": "portInNumber", "isEnabled": false } ], "serviceSpecification": { "id": "91722233", "name": "uniqueServiceId" } } ] |
| feature[] | Object Array | This is ObjectArray of feature for datamodel refer "feature subResource - dataMode" | Y(PA),N(CWC) | [ { "id": "8767249754", "name": "phoneNumber", "feature": [ { "name": "portInNumber", "isEnabled": false } ], "serviceSpecification": { "id": "91722233", "name": "uniqueServiceId" } } ] |
| supportingService[].serviceSpecification.id | string | unique identifier | N/A(PA), Y(CWC) | [ { "id": "8767249754", "name": "phoneNumber", "feature": [ { "name": "portInNumber", "isEnabled": false } ], "serviceSpecification": { "id": "91722233", "name": "uniqueServiceId" } } ] |
| supportingService[].serviceSpecification.name | string | Name of the related entity. | N/A(PA), Y(CWC) | [ { "id": "8767249754", "name": "phoneNumber", "feature": [ { "name": "portInNumber", "isEnabled": false } ], "serviceSpecification": { "id": "91722233", "name": "uniqueServiceId" } } ] |
supportingService.feature subResource - dataModel
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| name | string | This is the name for the feature | Y(PA),N(CWC) | [ { "name": "portInNumber", "isEnabled": false } ] |
| isEnabled | string | True if this feature is enabled. Default is true | Y(PA),N(CWC) | [ { "name": "portInNumber", "isEnabled": false } ] |
serviceCharacteristic subResource - dataModel
| field name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| id | string | identifier of the characteristic | Y(PA,CWC) | { "id": "3543", "name": "Internet ADSL 2Mbps/512 Kbps (prepaid)", "value": { "productStatusCode": "Z", "uniqueProductId": "62430422", "productActive": false, "price": 0, "isPrimary": false, "@type": "product" } } |
| name | string | name of the characteristic | Y(PA,CWC) | { "id": "3543", "name": "Internet ADSL 2Mbps/512 Kbps (prepaid)", "value": { "productStatusCode": "Z", "uniqueProductId": "62430422", "productActive": false, "price": 0, "isPrimary": false, "@type": "product" } } |
| value | string | value of the characteristic Here it is an object with the product details. | Y(PA),N(CWC) | { "id": "3543", "name": "Internet ADSL 2Mbps/512 Kbps (prepaid)", "value": { "productStatusCode": "Z", "uniqueProductId": "62430422", "productActive": false, "price": 0, "isPrimary": false, "@type": "product" } } |
relatedParty subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| id | string | identified of the party. Here it is accountNumber. | Y(CWC,PA) | { "id": "219061570000", "role": "account" } |
| role | string | Role of the party. | Y(CWC,PA) | { "id": "219061570000", "role": "account" } |
serviceOrderItem subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| serviceOrderId | string | identifier of the serviceOrder | N(CWC,PA) | { "serviceOrderId": "UJ73870", "itemId": "60227483" } |
| itemId | string | identifier of the item | N(CWC,PA) | { "serviceOrderId": "UJ73870", "itemId": "60227483" } |
place subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | example |
|---|---|---|---|---|
| id | string | place id | N(CWC,PA) | { "id": "80769153", "role": "ServiceAddress", "streetName": "PANAMA", "district": "CALLE 1RA", "province": "456 APT 19" } |
| role | string | role of the address. example: billingAddress, serviceAddress.... | N(CWC,PA) | { "id": "80769153", "role": "ServiceAddress", "streetName": "PANAMA", "district": "CALLE 1RA", "province": "456 APT 19" } |
| streetName | string | name of the street | N(CWC,PA) | { "id": "80769153", "role": "ServiceAddress", "streetName": "PANAMA", "district": "CALLE 1RA", "province": "456 APT 19" } |
| district | string | name of the district | N(CWC,PA) | { "id": "80769153", "role": "ServiceAddress", "streetName": "PANAMA", "district": "CALLE 1RA", "province": "456 APT 19" } |
| province | string | province code | N(CWC,PA) | { "id": "80769153", "role": "ServiceAddress", "streetName": "PANAMA", "district": "CALLE 1RA", "province": "456 APT 19" } |
Key considerations
- Please refer the following link for sample responses DXP UX - GET service
PA implementation
- This is implemented for FIXED, POSTPAID.
- The service and product details are fetched from Liberate based on the accountNumber.
- To fetch only active services and products , the 'state' queryParam should be sent as "Active". For Liberate Active Services/Products , the possible states are "W".
- If the value of queryParam 'state' is not sent as Active, then services and products of all states are provided.
For all the dateTime fields
- Any datetime before 1908-04-22 will show offset -05:18
- Any datetime on or after 1908-04-22 will show offset -05:00
In the response payload, "id" field is the MSISDN / serviceNumber.
- To retrieve optimized Response, queryParam 'filter' should be sent as 'optimize'.
- If queryParam 'filter' is sent as 'optimize' then serviceCharacteristic[].value.price (product price) will not be reflected in the response.
Possible states of liberate services
A - Allocated,
B - Barred,
C - Ceased,
D - Disabled,
R - Request Temporary Reco,
S - Request Temporary Discharge,
T - TFS,
W - Working,
X - Ceasing,
Z - Cancelled Before WorkingPossible states of liberate products
A - Allocated,
C - Ceased,
W - Working,
X - Ceasing,
Z - Cancelled Before WorkingPossible values of serviceType
POSTPAID
FIXED
PREPAIDKey considerations for CWC (flow markets)
- This is implemented for FIXED, POSTPAID and PREPAID lines.
- This is implemented for CWC BUS CWC-Anguilla(AI), CWC-Antigua(AG), CWC-British Virgin Islands (BVI)(VG), CWC-Cayman(KY), CWC-Dominica(DM), CWC-Grenada(GD), CWC-Jamaica(JM), CWC-Montserrat(MS), CWC-St Kitts(KN), CWC-StVincent(VC), CWC-Turks&Caicos(TKI)(TC)
- The service and product details are fetched from Liberate and Cerillion BSS based on the accountNumber. As of now , we haven't considered Amdocs.
- To fetch only active services and products , the 'state' queryParam should be sent as "Active". For Liberate Active Services/Products , the possible states are "W" and for Cerillion Active Services/Products , the possible states are "CU" , "TP and "RP".
- For cerillion, products include serviceProducts, addons and equipments.
- For Liberate , payload.serviceCharacteristic[].value.productType is always "ServiceProduct". For Cerillion, payload.serviceCharacteristic[].value.productType can be "service", "addOns" and "equipmemt".
- Assuming that the requirement is to provide serviceLevel products not accountLevel Products for Cerillion.
- We will be providing servicePackageId assigned to service in payload.supportingResource[].id.
- If the value of queryParam 'state' is not sent as Active, then services and products of all states are provided.10.The service package can only be retrieved for Liberate.
Possible states of cerillion services and products
CU - Current ,
TA - Transfer Await ,
FA - Fit Await ,
CA - Cancelled,
RP - Recovery Pending,
TP - Transfer Pending,
RE - Recovered,
TR - Transferred,
MP - Move Pending,
MA - Move AwaitPossible states of liberate services
A - Allocated,
B - Barred,
C - Ceased,
D - Disabled,
R - Request Temporary Reco,
S - Request Temporary Discharge,
T - TFS,
W - Working,
X - Ceasing,
Z - Cancelled Before WorkingPossible states of liberate products
A - Allocated,
C - Ceased,
W - Working,
X - Ceasing,
Z - Cancelled Before WorkingPossible values of cerillion serviceTypes
AV - Analog Video,
CG - CUG Owner,
CL - Cloud,
DA - Data,
DS - DSL,
DV - Digital Video,
ER - Equipment Rental,
GM - Mobile,
LM - Liberate Mobile,
TP - Voice,
XX - General,
3P - Other Suppliers Products,
BC - Business ConsultantPossible values of liberate serviceTypes
AA - Advertising Agency
AD - Auto Dialling Device
AX - AUDIOTEXT NUMBERS
C4 - Call 400 Service
C8 - 800 Service
CB - Conference Bridge
CC - Calling Card
CD - Cellular Dealer
CE - Mobile
DA - Directory Advertising
DD - Dealer Service
DN - Dealer Service
DS - Broadband
DW - Digital WWL
FP - Dummy FP service type
GU - GPRS Service
HD - Home Direct
HG - Homefone-To-Go
ID - IDAS
IN - Internet Service
JO - JOB ORDER
JS - Interconnect Joining Service
LC - Leased Circuit
LL - Leased Line Service
LM - eLearning
MD - MONITORING DEVICE
ML - MPLS Service
MT - Metro Service
P9 - 900 Calls
RP - Mobile Reward Points
SU - Sundry
TG - Telegram
TP - Landline
TX - Telex
UM - Urban Man Channel
VI - Voice Over IP
VS - VSAT
VT - VSAT Service
WM - Wireless ADSL/Wi-Max
WS - Wireless ADSL
XX - DUMMY AGENCY CARDS
FX - Fax
LP - C&W Conferencing on Demand
S8 - SMS Service
BU - Bundled Services
CZ - CloudBlue
FD - BLUU Streaming App
VP - Private Voice Mail
TI - TV
G8 - Toll Free Data
MV - Personal Voice Mail2. GET /service/{id}
This operation retrieves the service details for the provided service number .
URL
https://[host]:[port]/dxp-ux/v1/{businessId}/service/{id}URL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
| lob | string | The Line of Business Identifier Allowed values: FIXED, POSTPAID | N |
Uri Params
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique identifier of the service. | Y(CWC) |
Data Model
Response Data Model
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) |
|---|---|---|---|
| id | string | Unique identifier | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| href | string | reference link of the service | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| serviceType | string | Business type of the service | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| name | string | Name of the service | Y(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| state | string | state of the service | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| category | string | Is it a customer facing or resource facing service | Y(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| isServiceEnabled | boolean | If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| hasStarted | boolean | If TRUE, this Service has already been started | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
| startDate | datetime | Date when the service starts | Y(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| serviceDate | datetime | Date when the service was created (whatever its status). | Y(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| endDate | datetime | Date when the service ends | Y(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| feature[] | array | A list of feature associated with this service | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| feature[].featureCharacteristic[] | array | This is a list of Characteristics for a particular feature. | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| feature[].featureCharacteristic[].name | string | Name of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| feature[].featureCharacteristic[].valueType | string | Data type of the value of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| feature[].featureCharacteristic[].value | string | Value of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| serviceCharacteristic[] | array | A list of characteristics that characterize this service | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) |
| serviceCharacteristic[].name | string | Name of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) |
| serviceCharacteristic[].valueType | string | Data type of the value of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) |
| serviceCharacteristic[].value | string | Value of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) |
| supportingResource[] | array | A list of supporting resources | N(CWC - Liberate, CWC - Cerillion), Y(CWC - Amdocs) |
| supportingResource[].id | string | The identifier of the referred entity. | N(CWC - Liberate, CWC - Cerillion), Y(CWC - Amdocs) |
| supportingResource[].name | string | Name of the referred entity. | N(CWC - Liberate, CWC - Cerillion), Y(CWC - Amdocs) |
| serviceOrderItem[] | array | A list of service order items related to this service | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| serviceOrderItem[].serviceOrderId | string | Unique identifier of a related entity. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| serviceOrderItem[].itemAction | string | action to be performed on the product | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) |
| serviceOrderItem[].@referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| relatedParty[] | array | A list of related party references | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| relatedParty[].id | string | The identifier of the referred entity. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| relatedParty[].@referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| supportingService[] | array | A list of supporting services | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| supportingService[].isServiceEnabled | boolean | If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| supportingService[].@type | string | When sub-classing, this defines the sub-class Extensible name | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| supportingService[].place[] | array | A list of places | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) |
| supportingService[].place[].id | string | The identifier of the place. | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) |
| supportingService[].place[].name | string | Name of the place | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) |
| place[] | array | A list of places | N(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| place[].id | string | The identifier of the referred entity. | N(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) |
| place[].addressLine1 | string | Address of the place based on addressType | N(CWC - Liberate, CWC - Cerillion), N/A(Amdocs) |
| place[].addressLine2 | string | Address of the place based on addressType | N(CWC - Liberate), N/A(CWC -Cerillion, Amdocs) |
| place[].addressLine3 | string | Address of the place based on addressType | N(CWC - Liberate), N/A(CWC -Cerillion, Amdocs) |
| place[].addressLine4 | string | Address of the place based on addressType | N(CWC - Liberate), N/A(CWC -Cerillion, Amdocs) |
| place[].addressLine5 | string | Address of the place based on addressType | N(CWC - Liberate), N/A(CWC -Cerillion, Amdocs) |
| place[].countryName | string | Country Name of the place. | N(CWC - Cerillion), N/A(CWC -Liberate, Amdocs) |
| place[].placeName | string | Name of the Place. | N(CWC - Cerillion), N/A(CWC -Liberate, Amdocs) |
| place[].postCode | string | Post code of the place. | N(CWC - Cerillion), N/A(CWC -Liberate, Amdocs) |
| place[].streetName | string | Street name of the place. | N(CWC - Cerillion), N/A(CWC -Liberate, Amdocs) |
| place[].@referredType | string | The actual type of the target instance when needed for disambiguation. | N(CWC - Cerillion), N/A(CWC -Liberate, Amdocs) |
| relatedEntity[] | array | A list of related entities in relationship with this service | Y(CWC - Amdocs), N/A(CWC - Liberate, CWC - Cerillion) |
| relatedEntity[].id | string | The identifier of the referred entity. | Y(CWC - Amdocs), N/A(CWC - Liberate, CWC - Cerillion) |
| relatedEntity[].@referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Amdocs), N/A(CWC - Liberate, CWC - Cerillion) |
| @type | string | When sub-classing, this defines the sub-class Extensible name | Y(CWC - Liberate, CWC - Cerillion, CWC - Amdocs) |
feature subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| featureCharacteristic | array | This is a list of Characteristics for a particular feature. | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) | [ { "name": "ServPackId", "valueType": "string", "value": "HPE_3Play" }, { "name": "nationalBillInd", "valueType": "boolean", "value": true }, { "name": "taxPlanCode", "valueType": "string", "value": "01" } ] |
feature.featureCharacteristic subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| name | string | Name of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) | { "name": "ServPackId", "valueType": "string", "value": "HPE_3Play" } |
| valueType | string | Data type of the value of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) | { "name": "ServPackId", "valueType": "string", "value": "HPE_3Play" } |
| value | string | Value of the characteristic | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) | { "name": "ServPackId", "valueType": "string", "value": "HPE_3Play" } |
serviceCharacteristic subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| name | string | Name of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) | { "name": "exchId", "valueType": "string", "value": "LUCX" } |
| valueType | string | Data type of the value of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) | { "name": "exchId", "valueType": "string", "value": "LUCX" } |
| value | string | Value of the characteristic | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) | { "name": "exchId", "valueType": "string", "value": "LUCX" } |
supportingResource subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| id | string | The identifier of the referred entity. | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) | { "id": "000000000000001", "name": "HandsetIMEI" } |
| name | string | Name of the referred entity. | N(CWC - Liberate), Y(CWC - Cerillion, CWC - Amdocs) | { "id": "000000000000001", "name": "HandsetIMEI" } |
serviceOrderItem subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| serviceOrderId | string | Unique identifier of a related entity. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | { "serviceOrderId": "GV5457J", "itemAction": "ALP" }, { "serviceOrderId": "7143", "@referredType": "Home Phone Starter Lite" } |
| itemAction | string | action to be performed on the product | N(CWC - Liberate), N/A(CWC - Cerillion, CWC - Amdocs) | { "serviceOrderId": "GV5457J", "itemAction": "ALP" }, { "serviceOrderId": "7143", "@referredType": "Home Phone Starter Lite" } |
| @referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | { "serviceOrderId": "GV5457J", "itemAction": "ALP" }, { "serviceOrderId": "7143", "@referredType": "Home Phone Starter Lite" } |
relatedParty subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| id | string | The identifier of the referred entity. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | { "id": "321830190000", "@referredType": "AccountNo" } |
| @referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | { "id": "321830190000", "@referredType": "AccountNo" } |
supportingService subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| isServiceEnabled | string | If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | [{ "@type": "exDirectory", "isServiceEnabled": false }, { "place": [ { "id": "3019", "name": "pinNumber" } ] }] |
| @type | string | When sub-classing, this defines the sub-class Extensible name | Y(CWC - Liberate, CWC - Cerillion), N/A(CWC - Amdocs) | [{ "@type": "exDirectory", "isServiceEnabled": false }, { "place": [ { "id": "3019", "name": "pinNumber" } ] }] |
| place | array | A list of places | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) | [{ "@type": "exDirectory", "isServiceEnabled": false }, { "place": [ { "id": "3019", "name": "pinNumber" } ] }] |
supportingService.place subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| id | string | The identifier of the place. | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) | { "id": "3019", "name": "pinNumber" } |
| name | string | Name of the place. | Y(CWC - Liberate), N/A(CWC - Amdocs, CWC - Cerillion) | { "id": "3019", "name": "pinNumber" } |
relatedEntity subResource - dataModel
| name | type | description | required (mandatory-Y, optional-N, Not applicable- N/A) | examples |
|---|---|---|---|---|
| id | string | The identifier of the referred entity. | Y(CWC - Amdocs), N/A(CWC - Liberate, CWC - Cerillion) | { "id": "4000039439", "@referredType": "BillingAccount" } |
| @referredType | string | The actual type of the target instance when needed for disambiguation. | Y(CWC - Amdocs), N/A(CWC - Liberate, CWC - Cerillion) | { "id": "4000039439", "@referredType": "BillingAccount" } |
Key considerations
- Please refer the following link for sample responses DXP UX - GET serviceDetails
Key considerations for CWC (flow markets)
- This is implemented for CWC BUs
- The service details are fetched from Liberate and Cerillion BSS based on the accountNumber and for Curacao business ID it fetches from Amdocs.
Possible states for cerillion services
CU - Current,
TA - Transfer Await,
FA - Fit Await,
CA - Cancelled,
RP - Recovery Pending,
TP - Transfer Pending,
RE - Recovered,
TR - Transferred,
MP - Move Pending,
MA - Move AwaitPossible states of liberate services
A - Allocated,
B - Barred,
C - Ceased,
D - Disabled,
R - Request Temporary Reco,
S - Request Temporary Discharge,
T - TFS,
W - Working,
X - Ceasing,
Z - Cancelled Before WorkingPossible values of cerillion serviceTypes
AV - Analog Video,
CG - CUG Owner,
CL - Cloud,
DA - Data,
DS - DSL,
DV - Digital Video,
ER - Equipment Rental,
GM - Mobile,
LM - Liberate Mobile,
TP - Voice,
XX - General,
3P - Other Suppliers Products,
BC - Business ConsultantPossible values of liberate serviceTypes
AA - Advertising Agency
AD - Auto Dialling Device
AX - AUDIOTEXT NUMBERS
C4 - Call 400 Service
C8 - 800 Service
CB - Conference Bridge
CC - Calling Card
CD - Cellular Dealer
CE - Mobile
DA - Directory Advertising
DD - Dealer Service
DN - Dealer Service
DS - Broadband
DW - Digital WWL
FP - Dummy FP service type
GU - GPRS Service
HD - Home Direct
HG - Homefone-To-Go
ID - IDAS
IN - Internet Service
JO - JOB ORDER
JS - Interconnect Joining Service
LC - Leased Circuit
LL - Leased Line Service
LM - eLearning
MD - MONITORING DEVICE
ML - MPLS Service
MT - Metro Service
P9 - 900 Calls
RP - Mobile Reward Points
SU - Sundry
TG - Telegram
TP - Landline
TX - Telex
UM - Urban Man Channel
VI - Voice Over IP
VS - VSAT
VT - VSAT Service
WM - Wireless ADSL/Wi-Max
WS - Wireless ADSL
XX - DUMMY AGENCY CARDS
FX - Fax
LP - C&W Conferencing on Demand
S8 - SMS Service
BU - Bundled Services
CZ - CloudBlue
FD - BLUU Streaming App
VP - Private Voice Mail
TI - TV
G8 - Toll Free Data
MV - Personal Voice Mail